<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkToggleAction: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
<link rel="prev" href="GtkAction.html" title="GtkAction">
<link rel="next" href="GtkRadioAction.html" title="GtkRadioAction">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkToggleAction.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkToggleAction.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkToggleAction.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkToggleAction.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GtkToggleAction.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkAction.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkRadioAction.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkToggleAction"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkToggleAction.top_of_page"></a>GtkToggleAction</span></h2>
<p>GtkToggleAction — An action which can be toggled between two states</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkToggleAction.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="returnvalue">GtkToggleAction</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkToggleAction.html#gtk-toggle-action-new" title="gtk_toggle_action_new ()">gtk_toggle_action_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkToggleAction.html#gtk-toggle-action-toggled" title="gtk_toggle_action_toggled ()">gtk_toggle_action_toggled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkToggleAction.html#gtk-toggle-action-set-active" title="gtk_toggle_action_set_active ()">gtk_toggle_action_set_active</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkToggleAction.html#gtk-toggle-action-get-active" title="gtk_toggle_action_get_active ()">gtk_toggle_action_get_active</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkToggleAction.html#gtk-toggle-action-set-draw-as-radio" title="gtk_toggle_action_set_draw_as_radio ()">gtk_toggle_action_set_draw_as_radio</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkToggleAction.html#gtk-toggle-action-get-draw-as-radio" title="gtk_toggle_action_get_draw_as_radio ()">gtk_toggle_action_get_draw_as_radio</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkToggleAction.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkToggleAction.html#GtkToggleAction--active" title="The “active” property">active</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkToggleAction.html#GtkToggleAction--draw-as-radio" title="The “draw-as-radio” property">draw-as-radio</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkToggleAction.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkToggleAction.html#GtkToggleAction-toggled" title="The “toggled” signal">toggled</a></td>
<td class="signal_flags">Run First</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkToggleAction.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkToggleAction.html#GtkToggleAction-struct" title="struct GtkToggleAction">GtkToggleAction</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkToggleAction.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GtkAction.html" title="GtkAction">GtkAction</a>
        <span class="lineart">╰──</span> GtkToggleAction
            <span class="lineart">╰──</span> <a class="link" href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a>
</pre>
</div>
<div class="refsect1">
<a name="GtkToggleAction.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkToggleAction implements
 <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkToggleAction.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkToggleAction.description"></a><h2>Description</h2>
<p>A <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> corresponds roughly to a <a class="link" href="GtkCheckMenuItem.html" title="GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>. It has an
“active” state specifying whether the action has been checked or not.</p>
</div>
<div class="refsect1">
<a name="GtkToggleAction.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-toggle-action-new"></a><h3>gtk_toggle_action_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="returnvalue">GtkToggleAction</span></a> *
gtk_toggle_action_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                       <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>,
                       <em class="parameter"><code>const <span class="type">gchar</span> *tooltip</code></em>,
                       <em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_toggle_action_new</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<p>Creates a new <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> object. To add the action to
a <a class="link" href="GtkActionGroup.html" title="GtkActionGroup"><span class="type">GtkActionGroup</span></a> and set the accelerator for the action,
call <a class="link" href="GtkActionGroup.html#gtk-action-group-add-action-with-accel" title="gtk_action_group_add_action_with_accel ()"><code class="function">gtk_action_group_add_action_with_accel()</code></a>.</p>
<div class="refsect3">
<a name="gtk-toggle-action-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>A unique name for the action</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>The label displayed in menu items and on buttons,
or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>A tooltip for the action, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>stock_id</p></td>
<td class="parameter_description"><p>The stock icon to display in widgets representing
the action, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-toggle-action-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a></p>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-toggle-action-toggled"></a><h3>gtk_toggle_action_toggled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_toggle_action_toggled (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_toggle_action_toggled</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<p>Emits the “toggled” signal on the toggle action.</p>
<div class="refsect3">
<a name="gtk-toggle-action-toggled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>the action object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-toggle-action-set-active"></a><h3>gtk_toggle_action_set_active ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_toggle_action_set_active (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>,
                              <em class="parameter"><code><span class="type">gboolean</span> is_active</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_toggle_action_set_active</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<p>Sets the checked state on the toggle action.</p>
<div class="refsect3">
<a name="gtk-toggle-action-set-active.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>the action object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>is_active</p></td>
<td class="parameter_description"><p>whether the action should be checked or not</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-toggle-action-get-active"></a><h3>gtk_toggle_action_get_active ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_toggle_action_get_active (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_toggle_action_get_active</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<p>Returns the checked state of the toggle action.</p>
<div class="refsect3">
<a name="gtk-toggle-action-get-active.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>the action object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-toggle-action-get-active.returns"></a><h4>Returns</h4>
<p> the checked state of the toggle action</p>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-toggle-action-set-draw-as-radio"></a><h3>gtk_toggle_action_set_draw_as_radio ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_toggle_action_set_draw_as_radio (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>,
                                     <em class="parameter"><code><span class="type">gboolean</span> draw_as_radio</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_toggle_action_set_draw_as_radio</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<p>Sets whether the action should have proxies like a radio action.</p>
<div class="refsect3">
<a name="gtk-toggle-action-set-draw-as-radio.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>the action object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>draw_as_radio</p></td>
<td class="parameter_description"><p>whether the action should have proxies like a radio
action</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-toggle-action-get-draw-as-radio"></a><h3>gtk_toggle_action_get_draw_as_radio ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_toggle_action_get_draw_as_radio (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_toggle_action_get_draw_as_radio</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<p>Returns whether the action should have proxies like a radio action.</p>
<div class="refsect3">
<a name="gtk-toggle-action-get-draw-as-radio.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>the action object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-toggle-action-get-draw-as-radio.returns"></a><h4>Returns</h4>
<p> whether the action should have proxies like a radio action.</p>
</div>
<p class="since">Since: 2.4</p>
</div>
</div>
<div class="refsect1">
<a name="GtkToggleAction.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkToggleAction-struct"></a><h3>struct GtkToggleAction</h3>
<pre class="programlisting">struct GtkToggleAction;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkToggleAction.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkToggleAction--active"></a><h3>The <code class="literal">“active”</code> property</h3>
<pre class="programlisting">  “active”                   <span class="type">gboolean</span></pre>
<p>Whether the toggle action should be active.</p>
<div class="warning"><p><code class="literal">GtkToggleAction:active</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<p>Owner: GtkToggleAction</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkToggleAction--draw-as-radio"></a><h3>The <code class="literal">“draw-as-radio”</code> property</h3>
<pre class="programlisting">  “draw-as-radio”            <span class="type">gboolean</span></pre>
<p>Whether the proxies for this action look like radio action proxies.</p>
<p>This is an appearance property and thus only applies if

<a class="link" href="GtkActivatable.html#GtkActivatable--use-action-appearance" title="The “use-action-appearance” property"><span class="type">“use-action-appearance”</span></a> is <code class="literal">TRUE</code>.</p>
<div class="warning"><p><code class="literal">GtkToggleAction:draw-as-radio</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<p>Owner: GtkToggleAction</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="GtkToggleAction.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkToggleAction-toggled"></a><h3>The <code class="literal">“toggled”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *toggleaction,
               <span class="type">gpointer</span>         user_data)</pre>
<p>Should be connected if you wish to perform an action
whenever the <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> state is changed.</p>
<div class="warning"><p><code class="literal">GtkToggleAction::toggled</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p></div>
<div class="refsect3">
<a name="GtkToggleAction-toggled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>toggleaction</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>